[MJARSIGNER-62] Enhanced documentation for usage of arguments #17
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The author of https://issues.apache.org/jira/projects/MJARSIGNER/issues/MJARSIGNER-62 would like to use a 2-element additional argument to the jarsigner command line. The author believes that the problem they are having is that maven-jarsigner-plugin (on top of the https://github.com/apache/maven-jarsigner project) is quoting the arguments, and that is causing the problem.
I believe that the author is not correct: it is how the arguments were used by the author that is the problem. But I still think that the author has a good point. I my opinion the
arguments
parameter is not properly documented. You must be experienced with Maven to understand how to use it. I have used Maven for many years, and I still have problems with this. This pull request improves the documentation, so it is understandable for even a novice Maven user. When this pull request is accepted, I think that MJARSIGNER-62 can be closed.As an example, the
-certchain
is used in the ticket description. For this specific parameter there already exists a dedicated parameter. If/when #14 is accepted this will also have a correct documentation on https://maven.apache.org/plugins/maven-jarsigner-plugin/sign-mojo.htmlAs an example, in this pull request, I have selected a parameter that maven-jarsigner-plugin does not have support for:
-signedjar file
. This is a good parameter as an example because I don’t think maven-jarsigner-plugin will implement support for this (since maven-jarsigner-plugin is used to sign many jarfiles, it does not make sense to overwrite every jar into a single output jarfile).Example of rendered output: